home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / mann / listbox.n < prev    next >
Text File  |  1994-09-20  |  14KB  |  430 lines
  1. '\"
  2. '\" Copyright (c) 1990 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/wish/man/RCS/listbox.n,v 1.15 93/04/15 08:26:00 ouster Exp $ SPRITE (Berkeley)
  22. '/" 
  23. .\" The definitions below are for supplemental macros used in Tcl/Tk
  24. .\" manual entries.
  25. .\"
  26. .\" .HS name section [date [version]]
  27. .\"    Replacement for .TH in other man pages.  See below for valid
  28. .\"    section names.
  29. .\"
  30. .\" .AP type name in/out [indent]
  31. .\"    Start paragraph describing an argument to a library procedure.
  32. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  33. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  34. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  35. .\"    needed;  use .AS below instead)
  36. .\"
  37. .\" .AS [type [name]]
  38. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  39. .\"    name are examples of largest possible arguments that will be passed
  40. .\"    to .AP later.  If args are omitted, default tab stops are used.
  41. .\"
  42. .\" .BS
  43. .\"    Start box enclosure.  From here until next .BE, everything will be
  44. .\"    enclosed in one large box.
  45. .\"
  46. .\" .BE
  47. .\"    End of box enclosure.
  48. .\"
  49. .\" .VS
  50. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  51. .\"    of man pages.
  52. .\"
  53. .\" .VE
  54. .\"    End of vertical sidebar.
  55. .\"
  56. .\" .DS
  57. .\"    Begin an indented unfilled display.
  58. .\"
  59. .\" .DE
  60. .\"    End of indented unfilled display.
  61. .\"
  62. '\"    # Heading for Tcl/Tk man pages
  63. .de HS
  64. .ds ^3 \\0
  65. .if !"\\$3"" .ds ^3 \\$3
  66. .if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
  67. .if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
  68. .if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
  69. .if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
  70. .if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
  71. .if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
  72. .if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
  73. .if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
  74. .if t .wh -1.3i ^B
  75. .nr ^l \\n(.l
  76. .ad b
  77. ..
  78. '\"    # Start an argument description
  79. .de AP
  80. .ie !"\\$4"" .TP \\$4
  81. .el \{\
  82. .   ie !"\\$2"" .TP \\n()Cu
  83. .   el          .TP 15
  84. .\}
  85. .ie !"\\$3"" \{\
  86. .ta \\n()Au \\n()Bu
  87. \&\\$1    \\fI\\$2\\fP    (\\$3)
  88. .\".b
  89. .\}
  90. .el \{\
  91. .br
  92. .ie !"\\$2"" \{\
  93. \&\\$1    \\fI\\$2\\fP
  94. .\}
  95. .el \{\
  96. \&\\fI\\$1\\fP
  97. .\}
  98. .\}
  99. ..
  100. '\"    # define tabbing values for .AP
  101. .de AS
  102. .nr )A 10n
  103. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  104. .nr )B \\n()Au+15n
  105. .\"
  106. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  107. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  108. ..
  109. '\"    # BS - start boxed text
  110. '\"    # ^y = starting y location
  111. '\"    # ^b = 1
  112. .de BS
  113. .br
  114. .mk ^y
  115. .nr ^b 1u
  116. .if n .nf
  117. .if n .ti 0
  118. .if n \l'\\n(.lu\(ul'
  119. .if n .fi
  120. ..
  121. '\"    # BE - end boxed text (draw box now)
  122. .de BE
  123. .nf
  124. .ti 0
  125. .mk ^t
  126. .ie n \l'\\n(^lu\(ul'
  127. .el \{\
  128. .\"    Draw four-sided box normally, but don't draw top of
  129. .\"    box if the box started on an earlier page.
  130. .ie !\\n(^b-1 \{\
  131. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  132. .\}
  133. .el \}\
  134. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  135. .\}
  136. .\}
  137. .fi
  138. .br
  139. .nr ^b 0
  140. ..
  141. '\"    # VS - start vertical sidebar
  142. '\"    # ^Y = starting y location
  143. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  144. .de VS
  145. .mk ^Y
  146. .ie n 'mc \s12\(br\s0
  147. .el .nr ^v 1u
  148. ..
  149. '\"    # VE - end of vertical sidebar
  150. .de VE
  151. .ie n 'mc
  152. .el \{\
  153. .ev 2
  154. .nf
  155. .ti 0
  156. .mk ^t
  157. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  158. .sp -1
  159. .fi
  160. .ev
  161. .\}
  162. .nr ^v 0
  163. ..
  164. '\"    # Special macro to handle page bottom:  finish off current
  165. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  166. '\"    # page bottom macro.
  167. .de ^B
  168. .ev 2
  169. 'ti 0
  170. 'nf
  171. .mk ^t
  172. .if \\n(^b \{\
  173. .\"    Draw three-sided box if this is the box's first page,
  174. .\"    draw two sides but no top otherwise.
  175. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  176. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  177. .\}
  178. .if \\n(^v \{\
  179. .nr ^x \\n(^tu+1v-\\n(^Yu
  180. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  181. .\}
  182. .bp
  183. 'fi
  184. .ev
  185. .if \\n(^b \{\
  186. .mk ^y
  187. .nr ^b 2
  188. .\}
  189. .if \\n(^v \{\
  190. .mk ^Y
  191. .\}
  192. ..
  193. '\"    # DS - begin display
  194. .de DS
  195. .RS
  196. .nf
  197. .sp
  198. ..
  199. '\"    # DE - end display
  200. .de DE
  201. .fi
  202. .RE
  203. .sp .5
  204. ..
  205. .HS listbox tk
  206. .BS
  207. '\" Note:  do not modify the .SH NAME line immediately below!
  208. .SH NAME
  209. listbox \- Create and manipulate listbox widgets
  210. .SH SYNOPSIS
  211. \fBlistbox\fI \fIpathName \fR?\fIoptions\fR?
  212. .SH "STANDARD OPTIONS"
  213. .LP
  214. .nf
  215. .ta 4c 8c 12c
  216. .VS
  217. \fBbackground\fR    \fBforeground\fR    \fBselectBackground\fR    \fBxScrollCommand\fR
  218. \fBborderWidth\fR    \fBfont\fR    \fBselectBorderWidth\fR    \fByScrollCommand\fR
  219. \fBcursor\fR    \fBgeometry\fR    \fBselectForeground\fR
  220. \fBexportSelection\fR    \fBrelief\fR    \fBsetGrid\fR
  221. .VE
  222. .fi
  223. .LP
  224. See the ``options'' manual entry for details on the standard options.
  225. .SH "WIDGET-SPECIFIC OPTIONS"
  226. .ta 4c
  227. .LP
  228. None.
  229. .BE
  230.  
  231. .SH DESCRIPTION
  232. .PP
  233. The \fBlistbox\fR command creates a new window (given by the
  234. \fIpathName\fR argument) and makes it into a listbox widget.
  235. Additional
  236. options, described above, may be specified on the command line
  237. or in the option database
  238. to configure aspects of the listbox such as its colors, font,
  239. text, and relief.  The \fBlistbox\fR command returns its
  240. \fIpathName\fR argument.  At the time this command is invoked,
  241. there must not exist a window named \fIpathName\fR, but
  242. \fIpathName\fR's parent must exist.
  243. .PP
  244. A listbox is a widget that displays a list of strings, one per line.
  245. When first created, a new listbox has no elements in its list.
  246. Elements may be added or deleted using widget commands described
  247. below.  In addition, one or more elements may be selected as described
  248. below.
  249. .VS
  250. If a listbox is exporting its selection (see \fBexportSelection\fR
  251. option), then it will observe the standard X11 protocols
  252. .VE
  253. for handling the selection;  listbox selections are available
  254. as type \fBSTRING\fR, consisting of a Tcl list with one entry
  255. for each selected element.
  256. .PP
  257. For large lists only a subset of the list elements will be
  258. displayed in the listbox window at once;  commands described below
  259. may be used to change the view in the window.  Listboxes allow
  260. .VS
  261. scrolling in both directions using the standard \fBxScrollCommand\fR
  262. and \fByScrollCommand\fR options.
  263. .VE
  264. They also support scanning, as described below.
  265.  
  266. .SH "WIDGET COMMAND"
  267. .PP
  268. The \fBlistbox\fR command creates a new Tcl command whose
  269. name is \fIpathName\fR.  This
  270. command may be used to invoke various
  271. operations on the widget.  It has the following general form:
  272. .DS C
  273. \fIpathName option \fR?\fIarg arg ...\fR?
  274. .DE
  275. \fIOption\fR and the \fIarg\fRs
  276. determine the exact behavior of the command.  The following
  277. commands are possible for listbox widgets:
  278. .TP
  279. \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
  280. Query or modify the configuration options of the widget.
  281. If no \fIoption\fR is specified, returns a list describing all of
  282. the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
  283. information on the format of this list).  If \fIoption\fR is specified
  284. with no \fIvalue\fR, then the command returns a list describing the
  285. one named option (this list will be identical to the corresponding
  286. sublist of the value returned if no \fIoption\fR is specified).  If
  287. one or more \fIoption\-value\fR pairs are specified, then the command
  288. modifies the given widget option(s) to have the given value(s);  in
  289. this case the command returns an empty string.
  290. \fIOption\fR may have any of the values accepted by the \fBlistbox\fR
  291. command.
  292. .TP
  293. \fIpathName \fBcurselection\fR
  294. .VS
  295. Returns a list containing the indices of
  296. all of the elements in the listbox that are currently selected.
  297. If there are no elements selected in the listbox then an empty
  298. string is returned.
  299. .VE
  300. .TP
  301. \fIpathName \fBdelete \fIfirst \fR?\fIlast\fR?
  302. Delete one or more elements of the listbox.  \fIFirst\fR and \fIlast\fR
  303. give the integer indices of the first and last elements in the range
  304. to be deleted.  If \fIlast\fR isn't specified it defaults to
  305. \fIfirst\fR, i.e. a single element is deleted.  An index of
  306. \fB0\fR corresponds to the first element in the listbox.  Either
  307. \fIfirst\fR or \fIlast\fR may be specified as \fBend\fR, in which
  308. case it refers to the last element of the listbox.  This command
  309. returns an empty string
  310. .TP
  311. \fIpathName \fBget \fIindex\fR
  312. Return the contents of the listbox element indicated by \fIindex\fR.
  313. \fIIndex\fR must be a non-negative integer (0 corresponds to
  314. the first element in the listbox), or it may also be specified as
  315. \fBend\fR to indicate the last element in the listbox.
  316. .TP
  317. \fIpathName \fBinsert \fIindex \fR?\fIelement element ...\fR?
  318. Insert zero or more new elements in the list just before the
  319. element given by \fIindex\fR.  If \fIindex\fR is specified as
  320. \fBend\fR then the new elements are added to the end of the
  321. list.  Returns an empty string.
  322. .TP
  323. \fIpathName \fBnearest \fIy\fR
  324. Given a y-coordinate within the listbox window, this command returns
  325. the index of the (visible) listbox element nearest to that y-coordinate.
  326. .TP
  327. \fIpathName \fBscan\fR \fIoption args\fR
  328. This command is used to implement scanning on listboxes.  It has
  329. two forms, depending on \fIoption\fR:
  330. .RS
  331. .TP
  332. \fIpathName \fBscan mark \fIx y\fR
  333. .VS
  334. Records \fIx\fR and \fIy\fR and the current view in the listbox
  335. window;  used in conjunction with later \fBscan dragto\fR commands.
  336. Typically this command is associated with a mouse button press in
  337. the widget.  It returns an empty string.
  338. .TP
  339. \fIpathName \fBscan dragto \fIx y\fR.
  340. This command computes the difference between its \fIx\fR and \fIy\fR
  341. arguments and the \fIx\fR and \fIy\fR arguments to the last
  342. \fBscan mark\fR command for the widget.
  343. It then adjusts the view by 10 times the
  344. difference in coordinates.  This command is typically associated
  345. .VE
  346. with mouse motion events in the widget, to produce the effect of
  347. dragging the list at high speed through the window.  The return
  348. value is an empty string.
  349. .RE
  350. .TP
  351. \fIpathName \fBselect \fIoption arg\fR
  352. This command is used to adjust the selection within a listbox.  It
  353. has several forms, depending on \fIoption\fR.  In all of the forms
  354. the index \fBend\fR refers to the last element in the listbox.
  355. .RS
  356. .TP
  357. \fIpathName \fBselect adjust \fIindex\fR
  358. Locate the end of the selection nearest to the element given by
  359. \fIindex\fR, and adjust that end of the selection to be at \fIindex\fR
  360. (i.e including but not going beyond \fIindex\fR).  The other
  361. end of the selection is made the anchor point for future
  362. \fBselect to\fR commands.  If the selection
  363. isn't currently in the listbox, then this command is identical to
  364. the \fBselect from\fR widget command.
  365. Returns an empty string.
  366. .TP
  367. \fIpathName \fBselect clear\fR
  368. .VS
  369. If the selection is in this listbox then it is cleared so that
  370. none of the listbox's elements are selected anymore.
  371. .VE
  372. .TP
  373. \fIpathName \fBselect from \fIindex\fR
  374. Set the selection to consist of element \fIindex\fR, and make
  375. \fIindex\fR the anchor point for future \fBselect to\fR widget
  376. commands.  Returns an empty string.
  377. .TP
  378. \fIpathName \fBselect to \fIindex\fR
  379. Set the selection to consist of the elements from the anchor
  380. point to element \fIindex\fR, inclusive.  The anchor point is
  381. determined by the most recent \fBselect from\fR or \fBselect adjust\fR
  382. command in this widget.  If the selection isn't in this widget,
  383. this command is identical to \fBselect from\fR.
  384. Returns an empty string.
  385. .RE
  386. .TP
  387. \fIpathName \fBsize\fR
  388. Returns a decimal string indicating the total number of elements
  389. in the listbox.
  390. .TP
  391. \fIpathName \fBxview \fIindex\fR
  392. .VS
  393. Adjust the view in the listbox so that character position \fIindex\fR
  394. is displayed at the left edge of the widget.
  395. Returns an empty string.
  396. .TP
  397. \fIpathName \fByview \fIindex\fR
  398. Adjust the view in the listbox so that element \fIindex\fR is
  399. displayed at the top of the widget.
  400. If \fIindex\fR is specified as \fBend\fR it indicates the last
  401. element of the listbox.  Returns an empty string.
  402. .VE
  403.  
  404. .SH "DEFAULT BINDINGS"
  405. .PP
  406. .VS
  407. Tk automatically creates class bindings for listboxes that give them
  408. the following default behavior:
  409. .IP [1]
  410. When button 1 is pressed over a listbox, the element underneath the
  411. mouse cursor is selected.  The mouse can be dragged to select a
  412. range of elements.
  413. .IP [2]
  414. The ends of the selection can be adjusted by dragging with mouse
  415. button 1 while the shift key is down;  this will adjust the end
  416. of the selection that was nearest to the mouse cursor when button
  417. 1 was pressed.
  418. .IP [3]
  419. The view in the listbox can be adjusted by dragging with mouse button 2.
  420. .PP
  421. The behavior of listboxes can be changed by defining new bindings for
  422. individual widgets or by redefining the class bindings.
  423. In addition, the procedure \fBtk_listboxSingleSelect\fR may be
  424. invoked to change listbox behavior so that only a single element
  425. may be selected at once.
  426. .VE
  427.  
  428. .SH KEYWORDS
  429. listbox, widget
  430.